Ferramenta: API REST
A ferramenta API REST (api_rest) permite que o agente chame um endpoint HTTP externo durante a conversa — por exemplo, para consultar um pedido, um cadastro ou disparar uma ação em outro sistema.
Configuração
| Campo | Descrição |
|---|---|
| URL do endpoint | Endereço chamado pela ferramenta. Obrigatório. |
| Método | GET, POST, PUT, PATCH ou DELETE. Padrão: GET. |
| Tipo de autenticação | Nenhuma, Bearer, Basic ou API Key. Padrão: nenhuma. |
| Token de autenticação | Exibido apenas quando o tipo de autenticação não é "Nenhuma". |
| Headers | Cabeçalhos HTTP adicionais, no formato chave/valor. |
Como funciona
O endpoint, método e autenticação são fixos — definidos por quem configura o agente. Durante a conversa, o modelo só decide os dados de entrada (input), que são enviados como query string em requisições GET/DELETE ou como corpo JSON em POST/PUT/PATCH.
- Bearer: o token é enviado no header
Authorization: Bearer <token>. - Basic: o token deve estar no formato
usuario:senha. - API Key: o token é enviado no header fixo
X-API-Key. Se o serviço externo exigir um nome de header diferente, use o campo Headers em vez do tipo de autenticação "API Key".
Se a chamada falhar, o agente recebe um erro genérico e a falha fica registrada nos logs — a conversa continua normalmente.
Sem lista de permissões de URL O Rouxinol chama a URL exatamente como configurada, sem validar se ela aponta para um endereço interno da sua rede. Cadastre apenas endpoints confiáveis e evite apontar para serviços internos que não deveriam ser acessíveis a partir do agente.